home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 April / EnigmA AMIGA RUN 17 (1997)(G.R. Edizioni)(IT)[!][issue 1997-04][EAR-CD].iso / EARCD / comm / amiex / WS_SH26.lha / WarpSearch_shell.doc < prev    next >
Text File  |  1996-10-30  |  7KB  |  198 lines
  1. WarpSearch_Shell V2.6 Documentation
  2.  
  3.  
  4. Introduction
  5. ------------
  6. This is the shell version of WarpSearch.
  7. It uses the boyer-moore search algorithm implemented in assembler code.
  8. This algorithm is the fastest available.
  9.  
  10.  
  11. Revision History
  12. ----------------
  13. Features
  14. --------
  15. V1.0:
  16. -pattern matching
  17. -asynchonous I/O
  18. -backwards/forwards counting of filelists
  19. -highlightning
  20.  
  21. V2.0:
  22. -now real reverse search (search code / buffer loading / dir counting)
  23. -residentable
  24. -DMA optimized
  25. -prompts always behind complete descriptions
  26. -simple flagging, also "f file1.lha f file2.lha"
  27. -ndirs file is used to be s-express compatible if no ndirs tooltype exists
  28. -colors for the description output
  29. -configurable via tooltypes (of the WarpSearch executable) or WarpSearch.config file
  30.  tooltypes override file config
  31.  
  32. V2.1:
  33. -bugfixed V2.0
  34.  If there were escape codes in the text of a file description the line was
  35.  repeated in an infinite loop but you were able to quit the program at the
  36.  prompt. No memory trashes or similar occured. This is fixed now. A harmless
  37.  byte read from adress 0 in the shell version was wiped out too.
  38.  
  39. V2.3:
  40. -added prompts if no args at start specified in bbs version
  41. -speedup due to asm code improvement and faster resource allocations (unbelieveable but true)
  42. -wildcard problem fixed
  43. -help rewritten
  44.  
  45. V2.6:
  46. -no-prompts-feature in config file
  47. -replaced dirx with full path in config (you can easily search through aminet filelists now)
  48. -replaced ns with s in prompt
  49. -faster code due to optimized initialisation of load buffers
  50. -changed date to amigadate
  51.  
  52. Installation
  53. ------------
  54. Copy WarpSearch_Shell and WarpSearch_Shell.config to the same directory.
  55. You may rename it to have versions with different configs e.g.
  56. ws and ws.config
  57. will work too.
  58. Adjust configuration paths.
  59.  
  60.  
  61. Usage
  62. -----
  63. compatible to /X z door with enhancements
  64.  
  65. z <pattern> <filelist#> <+/-/r>
  66.  
  67. Example usage:
  68. "z foo"      (searches in upload dir for "foo" forwards).
  69. "z foo r"    (searches in upload dir reverse).
  70.  
  71. "z foo 3 r"  (searches in dir3 reverse).
  72. "z foo a +"  (searches from dir1 up for "foo").
  73.  
  74. "z foo a -"  (searches from upload dir down for "foo").
  75. "z foo 2 +"  (searches from dir2 up for "foo").
  76. "z foo 1"    (searches dir1 only for "foo").
  77.  
  78. Wildcards in pattern are allowed, like "z foo*bar" or "z warp*V1.0*"
  79. Use "z foo*bar 2 +" to search from dir2 upwards. Default is downwards search.
  80. The pattern must match an expression in one line.
  81. Patterns are not case sensitive. Only "*" is accepted as a wildcard and no
  82. other constructions like "#?","?" , which noone needs anyway in this application.
  83.  
  84. Use "z ?" for short help.
  85.  
  86. Info
  87. ----
  88. Due to the boyer-moore algorithm the longer the pattern (w/o wildcards)
  89. the shorter the search time.
  90.  
  91. The complete filedescription including filename etc. is searched through.
  92. We, the authors, think that this magic code is the fastest search routine ever
  93. made for an /X like filelist, because the 100% assembler boyer-moore search
  94. routine with pattern matching and highlightning is optimized for cpu cycles by
  95. hand, some magic is done for splitted filedescriptions, asychronous I/O
  96. optimized even for 68040. (cache flushing problem)
  97.  
  98. On our system the bottleneck is the Fast-SCSI-II Baracuda drive with a
  99. Fast-SCSI-II CyberSCSI Controller that does 7MB/s, and the code is 3 times
  100. faster if the filelist is in RAM with 50MB/s burst.
  101.  
  102. The maximum length of a description line allowed is 1000 chars. Since /X
  103. allows 80 chars/line as maximum we think this is no bug. If a line is longer
  104. than 1000 chars enforcer hits may occur. A check for line length would slow
  105. down the code significantly. That`s why we don`t do it.
  106.  
  107. For those who are interested, a short explanation of what "double buffered
  108. async I/O" means:
  109. Due to the coolness of the Amiga, SCSI is the most accepted standard on this
  110. platform (..well if we dont consider 4000 desktops..). SCSI has the ability
  111. to transfer data per DMA, thus meaning without using the processor. This is
  112. were async I/O comes in. A program using double buffered async I/O lets the
  113. filesystem first fill up one buffer, then sends the request to fill up the
  114. second buffer, and while the HD is busy transfering data to the 2nd buffer the
  115. processor is free to do its work on the first one. As you can imagine this
  116. technique dramatically speeds up the whole process.
  117.  
  118. Shell version now included.
  119.  
  120. A pseudo door that calls the door to be debugged is now developed. This way you
  121. can use SAS/C`s debugger cpr easily. If you need it just ask.
  122.  
  123. Send your suggestions or bug reports to crayor@cs.tu-berlin.de or
  124. dres@cs.tu-berlin.de.
  125.  
  126. Reverse search is quite slow, because the seeking in the filelist (which is
  127. even asynchronous) takes 87% of the execution time on Crayor`s system (060&
  128. CyberScsi). Use a cache program like DynamiCache V1.02 by Christopher A. Wolf
  129. with big memory values to make reverse search as fast as forwards search.
  130.  
  131. Maybe a scsi RAID system could be a good solution for reverse searching too,
  132. if you have one please contact Crayor!
  133.  
  134. For the Amiga a "mini raid system" for 2 equal drives is available. If you have
  135. this please contact Crayor. It seems to be software transparent and looks like
  136. just one scsi drive as I was told. This should almost double average transfer
  137. speeds.
  138.  
  139. Memory Requirements
  140. -------------------
  141. Approx. 2*blocksize*100 bytes which is about 100k for load buffers plus 20k
  142. for print buffer plus code size
  143. (blocksize is usually 512 bytes)
  144.  
  145. Shell Version
  146. -------------
  147. The shell version needs a config file with the name
  148. progdir:<executable_name>.config
  149.  
  150. This way you can have several instances of WarpSearch_shell with different
  151. names for your filelist collections.
  152.  
  153. So rename the shell version for example to:
  154.  
  155. TFuckup! and the config file to TFuckup!.config and
  156. DeathRow and the config file to DeathRow.config
  157.  
  158. and you can search in two filelist collections, one for each bbs.
  159.  
  160. Look at the example file "WarpSearch_shell.config" for the construction of
  161. the config files.
  162. Remember that characters like ´+´ have special meanings in the shell so use
  163. " to override these special meanings e.g. "+".
  164. If you hit return while not beeing at a prompt the output will be wired
  165. ofcoz.
  166.  
  167.  
  168. Greetz
  169. ------
  170. Some hellos to the following guys:
  171.  
  172. "Ibo"  - with his always busy or down BBS, so that we weren`t able to abuse
  173.          his BBS for beta testing ;)
  174.  
  175. Hijack - thx for the cool name of this door m8. (yep! "WarpSearch" actually was
  176.          his idea)
  177.  
  178. SCSI   - for his help on using iwan.device and other help
  179.  
  180. Amok   - for the address of Mr.F
  181.  
  182. STC    - for the competition of coding the fastest search code for /X filelists
  183.  
  184. Hydra  - for still developing hbbs
  185.  
  186. Dave Haynie
  187.        - for answering my several emails
  188.  
  189. The Baron (Mats N.)
  190.        - for reporting the (minor!?) esc-code bug in V2.0 that leeded to V2.1
  191.  
  192. shadower (M. R. T.)
  193.        - for some good suggestions for V2.1
  194.  
  195. Looking for good beta testers!
  196.  
  197. Cool MUI and AmiExpress BBS versions are available. Check the aminet! /comm/amiex
  198.